api/invoices/{id} (Get)

Get	api/invoices/{id}

In This Topic

Resource Path: /sites/{company-id}/api/invoices/{id}

Uri: https://secure.ontime360.com/sites/{company-id}/api/invoices/{id}

Description

Retrieves a single Invoice object assigned to a given identifier.

Parameters

Name	Description	Data Type
id	The unique identifier of an Invoice as a Guid.	string

200 Response

The response body is of type Invoice.

Returns a comprehensive Invoice object.

Invoice

Represents a comprehensive Invoice record within the OnTime API.

Customer : string

The unique Guid identifier referencing the Customer record assigned to this Invoice.

Orders : Array[]

The collection of unique Guid identifiers referencing all Order records assigned to this Invoice.

ID : string

The unique identifier for this Invoice record.

InvoiceNumber : integer

The number assigned to this Invoice.

Date : string

The date this Invoice was generated.

DueDate : string

The date this Invoice is due to be paid by a Customer.

IsPaid : boolean

Indicates if this Invoice has been paid in full.

Memo : string

Any additional comments given to this Invoice.

TransferredToQuickBooksDesktop : boolean

Indicates if this Invoice has been exported to QuickBooks via OnTime Management Suite.

TotalAmount : number

The total amount due for this Invoice.

Fault Responses

Fault	Description
400	Request was improperly formatted, contained invalid data, or contained incorrect values. See response body for more information.
401	Authorization key is invalid or no longer exists.
403	Authorization key does not have permission to perform this action, or does not have permission to access the requested data. See response body for more information.